Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update installation guide #53

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update installation guide #53

wants to merge 4 commits into from

Conversation

me-pic
Copy link
Contributor

@me-pic me-pic commented Apr 13, 2023

Reference physiopy/prep4phys#6

Update peakdet installation guide.

Proposed Changes

  • Change instructions to install peakdet through PyPi
  • Add different sections for Linux, Mac, Window

Change Type

  • bugfix (+0.0.1)
  • minor (+0.1.0)
  • major (+1.0.0)
  • refactoring (no version update)
  • test (no version update)
  • infrastructure (no version update)
  • documentation (no version update)
  • other

Checklist before review

  • I added everything I wanted to add to this PR.
  • [Code or tests only] I wrote/updated the necessary docstrings.
  • [Code or tests only] I ran and passed tests locally.
  • [Documentation only] I built the docs locally.
  • My contribution is harmonious with the rest of the code: I'm not introducing repetitions.
  • My code respects the adopted style, especially linting conventions.
  • The title of this PR is explanatory on its own, enough to be understood as part of a changelog.
  • I added or indicated the right labels.
  • I added information regarding the timeline of completion for this PR.
  • Please, comment on my PR while it's a draft and give me feedback on the development!

@me-pic
Copy link
Contributor Author

me-pic commented Apr 13, 2023

Still need to add the following section:
Installation without pip

@smoia
Copy link
Member

smoia commented Apr 13, 2023

Thank you @me-pic! Do you want me to review now or should I wait for that?

@smoia smoia added the Documentation This issue or PR is about the documentation label Apr 13, 2023
@me-pic
Copy link
Contributor Author

me-pic commented Apr 14, 2023

@smoia I retried to check if the installation could without pip on Mac, and I still had the same error as yesterday. It seems to be related with that specification !=*rc* in the requirements in the cfg file. I have the same issue trying to install phys2bids without pip.
Is the pip installation enough or should we also add the installation without pip ? I could look a bit more into the error if needed !

@smoia
Copy link
Member

smoia commented Apr 14, 2023

I have the feeling that later versions of setuptools do not like the "!rc" specification - also our tests on CircleCI are failing.
Can you tell me which version of setuptool you have?

@me-pic
Copy link
Contributor Author

me-pic commented Apr 14, 2023

setuptools==67.6.1

@smoia
Copy link
Member

smoia commented Apr 27, 2023

@me-pic, what is the status on this PR? Is it ready for review?
If not, can you change its stage to draft?

@maestroque maestroque mentioned this pull request Apr 15, 2024
Merged
18 tasks
smoia
smoia reviewed Apr 18, 2024
View reviewed changes
docs/installation.rst Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@smoia smoia smoia left review comments

Assignees
No one assigned
Labels
Documentation This issue or PR is about the documentation
Projects
Physiopy
Status: PR needs review
peakdet
Status: PR to review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@me-pic @smoia